package de.dopichaj.labrador.search.hit;

/**
 * Abstract implementation of hits.
 * None of the related information except the score is stored directly; the convenience
 * methods that do more than simply return the stored fields are implemented, calling
 * the accessors that the subclass must provide.
 */
public abstract class AbstractHit implements Hit {

    private float score;

    /* (non-Javadoc)
     * @see de.dopichaj.labrador.search.hit.Hit#getScore()
     */
    public float getScore() {
        return score;
    }

    /* (non-Javadoc)
     * @see de.dopichaj.labrador.search.hit.Hit#setScore(float)
     */
    public void setScore(float score) {
        if (Float.isNaN(score)) {
            throw new IllegalArgumentException("Setting score of " + this + " to NaN");
        }
        this.score = score;
    }
    
    @Override
    public String toString() {
        return "[file: " + getFile() + ", xpath: " + getXPath() +
                " score: " + score + ", length: " + getContentLength()  + "];";
    }
    
    /* (non-Javadoc)
     * @see de.dopichaj.labrador.search.hit.Hit#getMarkup()
     */
    public String getMarkup() {
        String xpath = getXPath();
        String markup = xpath.substring(xpath.lastIndexOf("/")+1,xpath.lastIndexOf("["));
        return markup;
    }
    

    /* (non-Javadoc)
     * @see de.dopichaj.labrador.search.hit.Hit#getEnclosingXPath()
     */
    public String getEnclosingXPath() {
        String xPath = getXPath();
        return xPath.substring(0,xPath.lastIndexOf("/"));
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof Hit) {
            Hit other = (Hit)obj;
            return getFile().equals(other.getFile()) && getXPath().equals(other.getXPath());
        } else {
            return false;
        }
    }
    
    @Override
    public int hashCode() {
        int hash = getFile().hashCode();
        for (final String part : getXPathParts()) {
            hash *= 31;
            hash += part.hashCode();
        }
        return hash;
    }

}
/*
Copyright (c) 2005 Benedikt Eger
Copyright (c) 2005-2007 Philipp Dopichaj

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/